[Beta] screen an outbound payment before sending it

curl --request POST \
  --url https://api.range.org/v2/screening/checks \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "client_entity_id": "6859927c-292e-4077-8d6a-70542c00a267",
  "network": "eth",
  "transfer_ref": "pay_8812",
  "counterparty_address": "0x62348b9125085ee5286aa68a7a17d15f090192bd",
  "destination_address": "<string>",
  "amount": "48000.00",
  "asset": "USDC"
}
'

import requests

url = "https://api.range.org/v2/screening/checks"

payload = {
    "client_entity_id": "6859927c-292e-4077-8d6a-70542c00a267",
    "network": "eth",
    "transfer_ref": "pay_8812",
    "counterparty_address": "0x62348b9125085ee5286aa68a7a17d15f090192bd",
    "destination_address": "<string>",
    "amount": "48000.00",
    "asset": "USDC"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    client_entity_id: '6859927c-292e-4077-8d6a-70542c00a267',
    network: 'eth',
    transfer_ref: 'pay_8812',
    counterparty_address: '0x62348b9125085ee5286aa68a7a17d15f090192bd',
    destination_address: '<string>',
    amount: '48000.00',
    asset: 'USDC'
  })
};

fetch('https://api.range.org/v2/screening/checks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.range.org/v2/screening/checks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'client_entity_id' => '6859927c-292e-4077-8d6a-70542c00a267',
    'network' => 'eth',
    'transfer_ref' => 'pay_8812',
    'counterparty_address' => '0x62348b9125085ee5286aa68a7a17d15f090192bd',
    'destination_address' => '<string>',
    'amount' => '48000.00',
    'asset' => 'USDC'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.range.org/v2/screening/checks"

	payload := strings.NewReader("{\n  \"client_entity_id\": \"6859927c-292e-4077-8d6a-70542c00a267\",\n  \"network\": \"eth\",\n  \"transfer_ref\": \"pay_8812\",\n  \"counterparty_address\": \"0x62348b9125085ee5286aa68a7a17d15f090192bd\",\n  \"destination_address\": \"<string>\",\n  \"amount\": \"48000.00\",\n  \"asset\": \"USDC\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.range.org/v2/screening/checks")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"client_entity_id\": \"6859927c-292e-4077-8d6a-70542c00a267\",\n  \"network\": \"eth\",\n  \"transfer_ref\": \"pay_8812\",\n  \"counterparty_address\": \"0x62348b9125085ee5286aa68a7a17d15f090192bd\",\n  \"destination_address\": \"<string>\",\n  \"amount\": \"48000.00\",\n  \"asset\": \"USDC\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.range.org/v2/screening/checks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"client_entity_id\": \"6859927c-292e-4077-8d6a-70542c00a267\",\n  \"network\": \"eth\",\n  \"transfer_ref\": \"pay_8812\",\n  \"counterparty_address\": \"0x62348b9125085ee5286aa68a7a17d15f090192bd\",\n  \"destination_address\": \"<string>\",\n  \"amount\": \"48000.00\",\n  \"asset\": \"USDC\"\n}"

response = http.request(request)
puts response.read_body

{
  "check_id": "6f1c2a9e-3b7d-4c55-9a0e-2d8f1e4b7c31",
  "direction": "outbound",
  "client_entity_id": "6859927c-292e-4077-8d6a-70542c00a267",
  "client_name": "Northwind Custody",
  "counterparty_address": "0x62348b9125085ee5286aa68a7a17d15f090192bd",
  "counterparty_name": null,
  "network": "eth",
  "amount": "48000.00",
  "asset": "USDC",
  "transfer_ref": "pay_8812",
  "transaction_id": null,
  "tx_hash": null,
  "is_approved_counterparty": false,
  "flagged": true,
  "reasons": [
    {
      "code": "not_approved_counterparty",
      "check_type": "approved_counterparties",
      "policy_key": "client.whitelist",
      "message": "Not one of the client's approved counterparties"
    }
  ],
  "checks": [
    {
      "kind": "address_risk",
      "check_type": "range_address_risk",
      "label": "Range address risk",
      "provider": "range",
      "provider_used": null,
      "status": "pass",
      "screened_at": "2026-10-07T09:12:03.120Z",
      "note": null,
      "reason": {
        "code": "not_approved_counterparty",
        "check_type": "approved_counterparties",
        "policy_key": "client.whitelist",
        "message": "Not one of the client's approved counterparties"
      },
      "risk_tier": "low",
      "travel_rule_status": "complete",
      "provider_detail": {
        "provider_status": "SETTLED"
      },
      "evidence": {
        "screen_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "score": 100,
        "sanctioned": true,
        "signals": [
          {
            "signal": "eu-sanctioned",
            "name": "EU Sanctioned",
            "pillar": "exposure",
            "severity": "severe",
            "summary": "1.24% of counterparty volume is eu-sanctioned, crossing the 1% (severe) threshold.",
            "confidence": null,
            "rule": {
              "name": "Sanctions exposure",
              "threshold": "1% (severe)"
            }
          }
        ],
        "listings": [
          {
            "authority": "OFAC",
            "program": "SDN",
            "list_key": "us_ofac_sdn",
            "listed_at": "2022-04-14",
            "delisted_at": null
          }
        ],
        "attribution": [
          {
            "name": "Lazarus Group",
            "category": "sanctions",
            "role": "owner",
            "polarity": "risk",
            "confidence": 98
          }
        ],
        "exposures": [
          {
            "name": "Tornado Cash",
            "category": "mixer",
            "direction": "incoming",
            "hop": "direct",
            "share": 0.123,
            "share_basis": "total-volume",
            "usd": 45210
          }
        ],
        "totals": {
          "incoming_usd": 367000,
          "outgoing_usd": 120000,
          "flagged_incoming_usd": 45210,
          "flagged_outgoing_usd": 0
        },
        "data_as_of": "2026-10-08T09:00:00Z",
        "provider_used": "chainalysis"
      }
    }
  ],
  "case_id": "0d9c7a1e-5b3f-4a2e-8c6d-1f2e3a4b5c6d",
  "travel_rule_followup": {
    "status": "awaiting",
    "executed_at": null,
    "tx_hash": null,
    "due_at": null,
    "resolved_at": null,
    "provider": "notabene",
    "case_id": null,
    "travel_rule_status": "complete"
  },
  "created_at": "2026-10-07T09:12:03.120Z",
  "verdict": "blocked",
  "status": "pending",
  "executed_at": null,
  "cancelled_at": null,
  "execution_case_id": null
}

{
  "check_id": "6f1c2a9e-3b7d-4c55-9a0e-2d8f1e4b7c31",
  "direction": "outbound",
  "client_entity_id": "6859927c-292e-4077-8d6a-70542c00a267",
  "client_name": "Northwind Custody",
  "counterparty_address": "0x62348b9125085ee5286aa68a7a17d15f090192bd",
  "counterparty_name": null,
  "network": "eth",
  "amount": "48000.00",
  "asset": "USDC",
  "transfer_ref": "pay_8812",
  "transaction_id": null,
  "tx_hash": null,
  "is_approved_counterparty": false,
  "flagged": true,
  "reasons": [
    {
      "code": "not_approved_counterparty",
      "check_type": "approved_counterparties",
      "policy_key": "client.whitelist",
      "message": "Not one of the client's approved counterparties"
    }
  ],
  "checks": [
    {
      "kind": "address_risk",
      "check_type": "range_address_risk",
      "label": "Range address risk",
      "provider": "range",
      "provider_used": null,
      "status": "pass",
      "screened_at": "2026-10-07T09:12:03.120Z",
      "note": null,
      "reason": {
        "code": "not_approved_counterparty",
        "check_type": "approved_counterparties",
        "policy_key": "client.whitelist",
        "message": "Not one of the client's approved counterparties"
      },
      "risk_tier": "low",
      "travel_rule_status": "complete",
      "provider_detail": {
        "provider_status": "SETTLED"
      },
      "evidence": {
        "screen_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "score": 100,
        "sanctioned": true,
        "signals": [
          {
            "signal": "eu-sanctioned",
            "name": "EU Sanctioned",
            "pillar": "exposure",
            "severity": "severe",
            "summary": "1.24% of counterparty volume is eu-sanctioned, crossing the 1% (severe) threshold.",
            "confidence": null,
            "rule": {
              "name": "Sanctions exposure",
              "threshold": "1% (severe)"
            }
          }
        ],
        "listings": [
          {
            "authority": "OFAC",
            "program": "SDN",
            "list_key": "us_ofac_sdn",
            "listed_at": "2022-04-14",
            "delisted_at": null
          }
        ],
        "attribution": [
          {
            "name": "Lazarus Group",
            "category": "sanctions",
            "role": "owner",
            "polarity": "risk",
            "confidence": 98
          }
        ],
        "exposures": [
          {
            "name": "Tornado Cash",
            "category": "mixer",
            "direction": "incoming",
            "hop": "direct",
            "share": 0.123,
            "share_basis": "total-volume",
            "usd": 45210
          }
        ],
        "totals": {
          "incoming_usd": 367000,
          "outgoing_usd": 120000,
          "flagged_incoming_usd": 45210,
          "flagged_outgoing_usd": 0
        },
        "data_as_of": "2026-10-08T09:00:00Z",
        "provider_used": "chainalysis"
      }
    }
  ],
  "case_id": "0d9c7a1e-5b3f-4a2e-8c6d-1f2e3a4b5c6d",
  "travel_rule_followup": {
    "status": "awaiting",
    "executed_at": null,
    "tx_hash": null,
    "due_at": null,
    "resolved_at": null,
    "provider": "notabene",
    "case_id": null,
    "travel_rule_status": "complete"
  },
  "created_at": "2026-10-07T09:12:03.120Z",
  "verdict": "blocked",
  "status": "pending",
  "executed_at": null,
  "cancelled_at": null,
  "execution_case_id": null
}

{
  "statusCode": 409,
  "error": "Conflict",
  "message": "transfer_ref already used with a different request",
  "code": "idempotency_conflict"
}

Screening

[Beta] screen an outbound payment before sending it

Runs the workspace’s outbound checks on the destination and decides: verdict “blocked” iff any check flagged (and a case opens), else “allowed”. Decides within about 5 seconds; a provider that cannot answer in time flags provider_unavailable (fail closed). Idempotent on transfer_ref: 201 for a new decision; 200 with Idempotent-Replayed: true for a replay of the same request; 409 idempotency_conflict for another request under the same transfer_ref; 409 in_progress (with Retry-After) while the first call is still deciding. Send the payment only on a 2xx response with verdict “allowed”. Anything else (a 4xx, a 5xx, a timeout, verdict “blocked”) means do not send; retry with the same transfer_ref, honouring Retry-After.

POST

screening

checks

curl --request POST \
  --url https://api.range.org/v2/screening/checks \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "client_entity_id": "6859927c-292e-4077-8d6a-70542c00a267",
  "network": "eth",
  "transfer_ref": "pay_8812",
  "counterparty_address": "0x62348b9125085ee5286aa68a7a17d15f090192bd",
  "destination_address": "<string>",
  "amount": "48000.00",
  "asset": "USDC"
}
'

import requests

url = "https://api.range.org/v2/screening/checks"

payload = {
    "client_entity_id": "6859927c-292e-4077-8d6a-70542c00a267",
    "network": "eth",
    "transfer_ref": "pay_8812",
    "counterparty_address": "0x62348b9125085ee5286aa68a7a17d15f090192bd",
    "destination_address": "<string>",
    "amount": "48000.00",
    "asset": "USDC"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    client_entity_id: '6859927c-292e-4077-8d6a-70542c00a267',
    network: 'eth',
    transfer_ref: 'pay_8812',
    counterparty_address: '0x62348b9125085ee5286aa68a7a17d15f090192bd',
    destination_address: '<string>',
    amount: '48000.00',
    asset: 'USDC'
  })
};

fetch('https://api.range.org/v2/screening/checks', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.range.org/v2/screening/checks",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'client_entity_id' => '6859927c-292e-4077-8d6a-70542c00a267',
    'network' => 'eth',
    'transfer_ref' => 'pay_8812',
    'counterparty_address' => '0x62348b9125085ee5286aa68a7a17d15f090192bd',
    'destination_address' => '<string>',
    'amount' => '48000.00',
    'asset' => 'USDC'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.range.org/v2/screening/checks"

	payload := strings.NewReader("{\n  \"client_entity_id\": \"6859927c-292e-4077-8d6a-70542c00a267\",\n  \"network\": \"eth\",\n  \"transfer_ref\": \"pay_8812\",\n  \"counterparty_address\": \"0x62348b9125085ee5286aa68a7a17d15f090192bd\",\n  \"destination_address\": \"<string>\",\n  \"amount\": \"48000.00\",\n  \"asset\": \"USDC\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.range.org/v2/screening/checks")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"client_entity_id\": \"6859927c-292e-4077-8d6a-70542c00a267\",\n  \"network\": \"eth\",\n  \"transfer_ref\": \"pay_8812\",\n  \"counterparty_address\": \"0x62348b9125085ee5286aa68a7a17d15f090192bd\",\n  \"destination_address\": \"<string>\",\n  \"amount\": \"48000.00\",\n  \"asset\": \"USDC\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.range.org/v2/screening/checks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"client_entity_id\": \"6859927c-292e-4077-8d6a-70542c00a267\",\n  \"network\": \"eth\",\n  \"transfer_ref\": \"pay_8812\",\n  \"counterparty_address\": \"0x62348b9125085ee5286aa68a7a17d15f090192bd\",\n  \"destination_address\": \"<string>\",\n  \"amount\": \"48000.00\",\n  \"asset\": \"USDC\"\n}"

response = http.request(request)
puts response.read_body

{
  "check_id": "6f1c2a9e-3b7d-4c55-9a0e-2d8f1e4b7c31",
  "direction": "outbound",
  "client_entity_id": "6859927c-292e-4077-8d6a-70542c00a267",
  "client_name": "Northwind Custody",
  "counterparty_address": "0x62348b9125085ee5286aa68a7a17d15f090192bd",
  "counterparty_name": null,
  "network": "eth",
  "amount": "48000.00",
  "asset": "USDC",
  "transfer_ref": "pay_8812",
  "transaction_id": null,
  "tx_hash": null,
  "is_approved_counterparty": false,
  "flagged": true,
  "reasons": [
    {
      "code": "not_approved_counterparty",
      "check_type": "approved_counterparties",
      "policy_key": "client.whitelist",
      "message": "Not one of the client's approved counterparties"
    }
  ],
  "checks": [
    {
      "kind": "address_risk",
      "check_type": "range_address_risk",
      "label": "Range address risk",
      "provider": "range",
      "provider_used": null,
      "status": "pass",
      "screened_at": "2026-10-07T09:12:03.120Z",
      "note": null,
      "reason": {
        "code": "not_approved_counterparty",
        "check_type": "approved_counterparties",
        "policy_key": "client.whitelist",
        "message": "Not one of the client's approved counterparties"
      },
      "risk_tier": "low",
      "travel_rule_status": "complete",
      "provider_detail": {
        "provider_status": "SETTLED"
      },
      "evidence": {
        "screen_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "score": 100,
        "sanctioned": true,
        "signals": [
          {
            "signal": "eu-sanctioned",
            "name": "EU Sanctioned",
            "pillar": "exposure",
            "severity": "severe",
            "summary": "1.24% of counterparty volume is eu-sanctioned, crossing the 1% (severe) threshold.",
            "confidence": null,
            "rule": {
              "name": "Sanctions exposure",
              "threshold": "1% (severe)"
            }
          }
        ],
        "listings": [
          {
            "authority": "OFAC",
            "program": "SDN",
            "list_key": "us_ofac_sdn",
            "listed_at": "2022-04-14",
            "delisted_at": null
          }
        ],
        "attribution": [
          {
            "name": "Lazarus Group",
            "category": "sanctions",
            "role": "owner",
            "polarity": "risk",
            "confidence": 98
          }
        ],
        "exposures": [
          {
            "name": "Tornado Cash",
            "category": "mixer",
            "direction": "incoming",
            "hop": "direct",
            "share": 0.123,
            "share_basis": "total-volume",
            "usd": 45210
          }
        ],
        "totals": {
          "incoming_usd": 367000,
          "outgoing_usd": 120000,
          "flagged_incoming_usd": 45210,
          "flagged_outgoing_usd": 0
        },
        "data_as_of": "2026-10-08T09:00:00Z",
        "provider_used": "chainalysis"
      }
    }
  ],
  "case_id": "0d9c7a1e-5b3f-4a2e-8c6d-1f2e3a4b5c6d",
  "travel_rule_followup": {
    "status": "awaiting",
    "executed_at": null,
    "tx_hash": null,
    "due_at": null,
    "resolved_at": null,
    "provider": "notabene",
    "case_id": null,
    "travel_rule_status": "complete"
  },
  "created_at": "2026-10-07T09:12:03.120Z",
  "verdict": "blocked",
  "status": "pending",
  "executed_at": null,
  "cancelled_at": null,
  "execution_case_id": null
}

{
  "check_id": "6f1c2a9e-3b7d-4c55-9a0e-2d8f1e4b7c31",
  "direction": "outbound",
  "client_entity_id": "6859927c-292e-4077-8d6a-70542c00a267",
  "client_name": "Northwind Custody",
  "counterparty_address": "0x62348b9125085ee5286aa68a7a17d15f090192bd",
  "counterparty_name": null,
  "network": "eth",
  "amount": "48000.00",
  "asset": "USDC",
  "transfer_ref": "pay_8812",
  "transaction_id": null,
  "tx_hash": null,
  "is_approved_counterparty": false,
  "flagged": true,
  "reasons": [
    {
      "code": "not_approved_counterparty",
      "check_type": "approved_counterparties",
      "policy_key": "client.whitelist",
      "message": "Not one of the client's approved counterparties"
    }
  ],
  "checks": [
    {
      "kind": "address_risk",
      "check_type": "range_address_risk",
      "label": "Range address risk",
      "provider": "range",
      "provider_used": null,
      "status": "pass",
      "screened_at": "2026-10-07T09:12:03.120Z",
      "note": null,
      "reason": {
        "code": "not_approved_counterparty",
        "check_type": "approved_counterparties",
        "policy_key": "client.whitelist",
        "message": "Not one of the client's approved counterparties"
      },
      "risk_tier": "low",
      "travel_rule_status": "complete",
      "provider_detail": {
        "provider_status": "SETTLED"
      },
      "evidence": {
        "screen_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "score": 100,
        "sanctioned": true,
        "signals": [
          {
            "signal": "eu-sanctioned",
            "name": "EU Sanctioned",
            "pillar": "exposure",
            "severity": "severe",
            "summary": "1.24% of counterparty volume is eu-sanctioned, crossing the 1% (severe) threshold.",
            "confidence": null,
            "rule": {
              "name": "Sanctions exposure",
              "threshold": "1% (severe)"
            }
          }
        ],
        "listings": [
          {
            "authority": "OFAC",
            "program": "SDN",
            "list_key": "us_ofac_sdn",
            "listed_at": "2022-04-14",
            "delisted_at": null
          }
        ],
        "attribution": [
          {
            "name": "Lazarus Group",
            "category": "sanctions",
            "role": "owner",
            "polarity": "risk",
            "confidence": 98
          }
        ],
        "exposures": [
          {
            "name": "Tornado Cash",
            "category": "mixer",
            "direction": "incoming",
            "hop": "direct",
            "share": 0.123,
            "share_basis": "total-volume",
            "usd": 45210
          }
        ],
        "totals": {
          "incoming_usd": 367000,
          "outgoing_usd": 120000,
          "flagged_incoming_usd": 45210,
          "flagged_outgoing_usd": 0
        },
        "data_as_of": "2026-10-08T09:00:00Z",
        "provider_used": "chainalysis"
      }
    }
  ],
  "case_id": "0d9c7a1e-5b3f-4a2e-8c6d-1f2e3a4b5c6d",
  "travel_rule_followup": {
    "status": "awaiting",
    "executed_at": null,
    "tx_hash": null,
    "due_at": null,
    "resolved_at": null,
    "provider": "notabene",
    "case_id": null,
    "travel_rule_status": "complete"
  },
  "created_at": "2026-10-07T09:12:03.120Z",
  "verdict": "blocked",
  "status": "pending",
  "executed_at": null,
  "cancelled_at": null,
  "execution_case_id": null
}

{
  "statusCode": 409,
  "error": "Conflict",
  "message": "transfer_ref already used with a different request",
  "code": "idempotency_conflict"
}

Authorizations

X-API-KEY

string

header

required

Authorization method required to allow user to access the api endpoints.

Body

application/json

client_entity_id

string

required

The client (an entity of type client) the payment is for.

Example:

"6859927c-292e-4077-8d6a-70542c00a267"

network

string

required

Network slug as the entity register uses it (eth, solana, arb1, …). Aliases such as ethereum are normalised.

Example:

"eth"

transfer_ref

string

required

Your id for this payment attempt: the idempotency key. Resending the same transfer_ref with the same request returns the stored decision (200, Idempotent-Replayed: true); with a different request, 409. A new attempt after a block needs a new transfer_ref.

Maximum string length: 128

Example:

"pay_8812"

counterparty_address

string

Where the payment goes. Required (or its deprecated alias destination_address).

Example:

"0x62348b9125085ee5286aa68a7a17d15f090192bd"

destination_address

string

deprecated

Deprecated alias of counterparty_address. Sending both naming different addresses is a 400.

amount

string

Amount in asset units (a decimal string, not base units).

Maximum string length: 78

Example:

"48000.00"

asset

string

Maximum string length: 32

Example:

"USDC"

Response

check_id

string

required

Example:

"6f1c2a9e-3b7d-4c55-9a0e-2d8f1e4b7c31"

direction

enum<string>

required

Available options:

inbound,

outbound

Example:

"outbound"

client_entity_id

string

required

Example:

"6859927c-292e-4077-8d6a-70542c00a267"

client_name

string

required

Example:

"Northwind Custody"

counterparty_address

string

required

Example:

"0x62348b9125085ee5286aa68a7a17d15f090192bd"

counterparty_name

string | null

required

Example:

null

network

string

required

Example:

"eth"

amount

string | null

required

Example:

"48000.00"

asset

string | null

required

Example:

"USDC"

transfer_ref

string | null

required

Example:

"pay_8812"

transaction_id

string | null

required

Example:

null

tx_hash

string | null

required

Example:

null

is_approved_counterparty

boolean

required

Example:

false

flagged

boolean

required

Example:

true

reasons

object[]

required

Show child attributes

checks

object[]

required

Show child attributes

case_id

string | null

required

The case the flag opened, null when it did not flag. A /v2/cases id: read and work it with GET /v2/cases/{id} (source_type transaction_screening).

Example:

"0d9c7a1e-5b3f-4a2e-8c6d-1f2e3a4b5c6d"

travel_rule_followup

object | null

required

Show child attributes

created_at

string

required

Example:

"2026-10-07T09:12:03.120Z"

verdict

enum<string>

Outbound only, always present there. Send only on "allowed".

Available options:

allowed,

blocked

Example:

"blocked"

status

enum<string>

Inbound only: pending while a check is awaited, then clear or flagged. Release a quarantined deposit on clear.

Available options:

pending,

clear,

flagged

executed_at

string | null

Example:

null

cancelled_at

string | null

Example:

null

execution_case_id

string | null

The /v2/cases id of the case a blocked transfer sent anyway opened.

Example:

null

Overview

API Reference

Alerting

Rule Catalogue

[Beta] screen an outbound payment before sending it

Authorizations

Body

Response